home *** CD-ROM | disk | FTP | other *** search
/ Aminet 21 / Aminet 21 (1997)(GTI - Schatztruhe)[!][Oct 1997].iso / Aminet / dev / gui / geometryengine.lha / GeometryEngine / docs / autodocs.txt
Encoding:
Text File  |  1997-08-27  |  8.9 KB  |  454 lines
  1. TABLE OF CONTENTS
  2.  
  3. GeometryEngine/GE_BeginResizeGeometry
  4. GeometryEngine/GE_CloseWindow
  5. GeometryEngine/GE_CreateGeometry
  6. GeometryEngine/GE_CreateGT
  7. GeometryEngine/GE_CreateGUI
  8. GeometryEngine/GE_FreeGeometries
  9. GeometryEngine/GE_FreeGT
  10. GeometryEngine/GE_FreeGUI
  11. GeometryEngine/GE_InitGeometry
  12. GeometryEngine/GE_OpenWindow
  13. GeometryEngine/GE_RenderGeometry
  14. GeometryEngine/GE_ResizeGeometry
  15. GeometryEngine/GE_BeginResizeGeometry   GeometryEngine/GE_BeginResizeGeometry
  16.  
  17.    NAME
  18.     GE_BeginResizeGeometryA    - Layout a GUI
  19.     GE_BeginResizeGeometry    - Varargs stub
  20.  
  21.    SYNOPSIS
  22.     success = GE_BeginResizeGeometry(GUI, Tags)
  23.  
  24.     BOOL GE_BeginResizeGeometry(GUI *, struct TagItem *)
  25.  
  26.     success = GE_BeginResizeGeometry(GUI, Tags,...)
  27.  
  28.     BOOL GE_BeginResizeGeometry(GUI *, Tag,...)
  29.  
  30.    FUNCTION
  31.     Begin doing a resize operation.  This is to be called when you get a 
  32.     IDCMP_SIZEVERIFY message from intuition.  You must call this function
  33.     twice -- once immediately, and once right after ReplyMsg()'ing the
  34.     IDCMP message.  This allows the system to do some work while the
  35.     user is fiddling with the sizing gadget, to improve performance 
  36.     (mostly this is for GadTools).
  37.  
  38.    INPUTS
  39.     Tags:
  40.  
  41.     GE_Geometry    - Resize this geometry under the given GUI envirionment
  42.  
  43.    RESULT
  44.  
  45.    EXAMPLE
  46.  
  47.    NOTES
  48.  
  49.    BUGS
  50.  
  51.    SEE ALSO
  52.  
  53. GeometryEngine/GE_CloseWindow                   GeometryEngine/GE_CloseWindow
  54.  
  55.    NAME
  56.     GE_CloseWindow    - Closes the window associated with a GUI structure
  57.  
  58.    SYNOPSIS
  59.     GE_CloseWindow(GUI)
  60.  
  61.     void GE_CloseWindow(GUI *)
  62.  
  63.    FUNCTION
  64.     Closes the window associated with the GUI
  65.  
  66.    INPUTS
  67.     GUI    - GUI with an open window
  68.  
  69.    RESULT
  70.  
  71.    EXAMPLE
  72.  
  73.    NOTES
  74.  
  75.    BUGS
  76.  
  77.    SEE ALSO
  78.     CloseWindow()
  79.  
  80. GeometryEngine/GE_CreateGeometry             GeometryEngine/GE_CreateGeometry
  81.  
  82.    NAME
  83.     GE_CreateGeometryA    - Create a Geometry structure
  84.     GE_CreateGeometry    - Varargs stub
  85.  
  86.    SYNOPSIS
  87.     Geometry = GE_CreateGeometryA(Flags, Width, Height, Tags)
  88.  
  89.     Geometry *GE_CreateGeometryA(ULONG, SHORT, SHORT, struct TagItem *)
  90.  
  91.     Geometry = GE_CreateGeometry(Flags, Width, Height, Tags,...)
  92.  
  93.     Geometry *GE_CreateGeometry(ULONG, SHORT, SHORT, Tag,...)
  94.  
  95.    FUNCTION
  96.     Create a Geometry structure, initialized to the given dimensions,
  97.     flags, and tags.
  98.  
  99.    INPUTS
  100.     Flags    - Flags
  101.  
  102.         GYF_PROP - Proportional (2D) layout (not currently implemented)
  103.  
  104.         GYF_HORIZ - This is a horizontaly layed out group.
  105.  
  106.         GYF_VERT - This is a verticaly layed out group.
  107.  
  108.         GYF_CUSTOM - We do something completely different.
  109.  
  110.         GYF_NONE - Don't render any frame.
  111.  
  112.         GYF_RECESS - Render a recessed frame
  113.  
  114.         GYF_RAISED - Render a raised frame
  115.  
  116.         GYF_RIDGE - Render a ridge frame
  117.  
  118.         GYF_THICK - Render a thickened frame (not implemented)
  119.  
  120.         GYF_HOOK - Specifying this flag means that you want to use
  121.                custom handling for this Geometry.  You MUST
  122.                supply the hooks!
  123.  
  124.  
  125.     Width, Height    - Dimensions of the Geometry.  A value of '0' is 
  126.               interpreted as the minimum size; any positive value
  127.               is a proportion, relative to other objects, of the
  128.               available space.
  129.  
  130.     Tags    - Additional tags:
  131.  
  132.     GE_Geometry    - A child geometry to be linked under this geometry.
  133.  
  134.     GE_RenderHook    - Do your custom rendering here.
  135.  
  136.     GE_MinsizeHook    - Return your minimum possible size.
  137.  
  138.     GE_ResizeHook    - Resize and relayout yourself.
  139.  
  140.     GE_FreeHook    - Free any data you allocated.
  141.  
  142.     GE_Object
  143.  
  144.    RESULT
  145.     Geometry    - Initialized Geometry structure
  146.  
  147.    EXAMPLE
  148.  
  149.    NOTES
  150.  
  151.    BUGS
  152.  
  153.    SEE ALSO
  154.  
  155. GeometryEngine/GE_CreateGT                         GeometryEngine/GE_CreateGT
  156.  
  157.    NAME
  158.     GE_CreateGT    - Create a GadTools object
  159.  
  160.    SYNOPSIS
  161.     Geometry = GE_CreateGT(Width, Height, Kind, Text, ID, Flags, Tags,...)
  162.  
  163.     Geometry *GE_CreateGT(SHORT, SHORT, ULONG, UBYTE *, UWORD, ULONG, Tag,...)
  164.  
  165.    FUNCTION
  166.     Creates a GadTools object.  In reality, this function creates a
  167.     Geometry with the GYF_LEAF flag set, and the hooks set to internal
  168.     GadTools support routines.
  169.  
  170.    INPUTS
  171.  
  172.     Width, Height - See GE_CreateGeometry.
  173.  
  174.     Kind, Text, ID, Flags, Tags - See GadTools Autodocs.
  175.  
  176.    RESULT
  177.  
  178.    EXAMPLE
  179.  
  180.    NOTES
  181.  
  182.    BUGS
  183.  
  184.    SEE ALSO
  185.  
  186. GeometryEngine/GE_CreateGUI                       GeometryEngine/GE_CreateGUI
  187.  
  188.    NAME
  189.     GE_CreateGUIA    - Create a basic GUI structure
  190.     GE_CreateGUI    - Varargs stub
  191.  
  192.    SYNOPSIS
  193.     GUI = GE_CreateGUI(Tags,...)
  194.  
  195.     GUI *GE_CreateGUI(Tag Tags,...)
  196.  
  197.     GUI = GE_CreateGUIA(Tags)
  198.  
  199.     GUI *GE_CreateGUIA(struct TagItem *)
  200.  
  201.    FUNCTION
  202.     Creates the basic GUI structure for holding GUI data (Geometry
  203.     structures, window font, etc), and initializes it.
  204.  
  205.    INPUTS
  206.     Tags:
  207.  
  208.     GE_ScreenName    - Open windows on this public screen
  209.  
  210.     GE_FontAttr    - Use this font
  211.  
  212.     GE_Geometry    - Link in and initialize this Geometry right now
  213.  
  214.    RESULT
  215.     GUI    - Initialized GUI structure
  216.  
  217.    EXAMPLE
  218.  
  219.    NOTES
  220.  
  221.    BUGS
  222.  
  223.    SEE ALSO
  224.     GE_InitGeometry(), GE_FreeGUI()
  225.  
  226. GeometryEngine/GE_FreeGeometries             GeometryEngine/GE_FreeGeometries
  227.  
  228.    NAME
  229.     GE_FreeGeometries    - Frees a Geometry structure
  230.  
  231.    SYNOPSIS
  232.     GE_FreeGeometries(GUI, Geometry)
  233.  
  234.     void GE_FreeGeometries(GUI *,Geometry *)
  235.  
  236.    FUNCTION
  237.     Frees a Geometry structure allocated with GE_CreateGeometry, and all
  238.     Geometry structures that have been linked in, including GadTools
  239.     objects and custom Geometries (by calling the GE_FreeHook function)
  240.  
  241.    INPUTS
  242.  
  243.    RESULT
  244.  
  245.    EXAMPLE
  246.  
  247.    NOTES
  248.  
  249.    BUGS
  250.  
  251.    SEE ALSO
  252.  
  253. GeometryEngine/GE_FreeGT                             GeometryEngine/GE_FreeGT
  254.  
  255.    NAME
  256.     GE_FreeGT    - Free a GadTools object
  257.  
  258.    SYNOPSIS
  259.     GE_FreeGT(GUI, Geometry)
  260.  
  261.     void GE_FreeGT(GUI *, Geometry *)
  262.  
  263.    FUNCTION
  264.     Frees a GadTools object previously allocated with GE_CreateGT()
  265.  
  266.    INPUTS
  267.  
  268.    RESULT
  269.  
  270.    EXAMPLE
  271.  
  272.    NOTES
  273.  
  274.    BUGS
  275.  
  276.    SEE ALSO
  277.  
  278. GeometryEngine/GE_FreeGUI                           GeometryEngine/GE_FreeGUI
  279.  
  280.    NAME
  281.     GE_FreeGUI    - Frees a GUI structure
  282.  
  283.    SYNOPSIS
  284.     GE_FreeGUI(GUI)
  285.  
  286.     void GE_FreeGUI(GUI *)
  287.  
  288.    FUNCTION
  289.     Frees a GUI structure allocated with GE_CreateGUI, and all Geometry
  290.     structures that have been linked in, including GadTools objects and
  291.     custom Geometries (by calling the GE_FreeHook function)
  292.  
  293.    INPUTS
  294.  
  295.    RESULT
  296.  
  297.    EXAMPLE
  298.  
  299.    NOTES
  300.  
  301.    BUGS
  302.  
  303.    SEE ALSO
  304.  
  305. GeometryEngine/GE_InitGeometry                 GeometryEngine/GE_InitGeometry
  306.  
  307.    NAME
  308.     GE_InitGeometryA - Initialize GUI structure
  309.     GE_InitGeometry    - Varargs stub
  310.  
  311.    SYNOPSIS
  312.     success = GE_InitGeometryA(GUI, Tags)
  313.  
  314.     BOOL GE_InitGeometryA(GUI *, struct TagItem *)
  315.  
  316.     success = GE_InitGeometry(GUI, Tags,...)
  317.  
  318.     BOOL GE_InitGeometry(GUI *, Tag,...)
  319.  
  320.    FUNCTION
  321.     Locks the screen, gets rendering parameters (DrawInfo and
  322.     VisualInfo), opens fonts.  Initializes Geometry structures, 
  323.     calculating the minimum sizes of all objects.  This only needs to be
  324.     done when adding geometries, or when something changes (like the
  325.     screen font).  Generaly, it should always be called just before 
  326.     opening the window.
  327.  
  328.    INPUTS
  329.     GUI    - Pointer to a GUI structure returned by GE_CreateGUI()
  330.  
  331.     Tags:
  332.  
  333.     GE_ScreenName    - Open windows on this public screen
  334.  
  335.     GE_FontAttr    - Use this font
  336.  
  337.     GE_Geometry    - Initialize this Geometry under the GUI envirionment
  338.               Note:  This does NOT link the Geometry in!
  339.  
  340.    RESULT
  341.     success - TRUE if everything was setup.
  342.  
  343.    EXAMPLE
  344.  
  345.    NOTES
  346.  
  347.    BUGS
  348.  
  349.    SEE ALSO
  350.  
  351. GeometryEngine/GE_OpenWindow                     GeometryEngine/GE_OpenWindow
  352.  
  353.    NAME
  354.     GE_OpenWindowA    - Opens the window associated with a GUI structure
  355.     GE_OpenWindow    - Varargs stub
  356.  
  357.    SYNOPSIS
  358.     Window = GE_OpenWindowA(GUI, Tags)
  359.  
  360.     struct Window *GE_OpenWindowA(GUI *, struct TagItem *)
  361.  
  362.     Window = GE_OpenWindow(GUI, Tags,...)
  363.  
  364.     struct Window *GE_OpenWindow(GUI *, Tag,...)
  365.  
  366.    FUNCTION
  367.     Opens the window, with gadgets, described by the GUI structure.  The
  368.     tags are the same as for OpenWindowTags().  The window will be opened
  369.      at the appropriate size for the contained gadgets.
  370.  
  371.    INPUTS
  372.  
  373.        Tags:  See OpenWindowTags()
  374.  
  375.    RESULT
  376.  
  377.    EXAMPLE
  378.  
  379.    NOTES
  380.  
  381.    BUGS
  382.  
  383.    SEE ALSO
  384.  
  385. GeometryEngine/GE_RenderGeometry             GeometryEngine/GE_RenderGeometry
  386.  
  387.    NAME
  388.     GE_RenderGeometryA    - Render all imagery for a Geometry
  389.     GE_RenderGeometry    - Varargs stub
  390.  
  391.    SYNOPSIS
  392.     success = GE_RenderGeometryA(GUI, Tags)
  393.  
  394.     BOOL GE_RenderGeometryA(GUI *, struct TagsItem *)
  395.  
  396.     success = GE_RenderGeometry(GUI, Tags,...)
  397.  
  398.     BOOL GE_RenderGeometry(GUI *, Tag,...)
  399.  
  400.    FUNCTION
  401.     Renders all Geometries to the window associated with the GUI.  This
  402.     will refresh all borders, GadTools gadgets, and call custom Geometry
  403.        rendering hooks.
  404.  
  405.    INPUTS
  406.     Tags:
  407.     
  408.     GE_Geometry    - Render this geometry under the given GUI envirionment
  409.  
  410.    RESULT
  411.  
  412.    EXAMPLE
  413.  
  414.    NOTES
  415.  
  416.    BUGS
  417.  
  418.    SEE ALSO
  419.  
  420. GeometryEngine/GE_ResizeGeometry             GeometryEngine/GE_ResizeGeometry
  421.  
  422.    NAME
  423.     GE_ResizeGeometryA    - Layout a GUI
  424.     GE_ResizeGeometry    - Varargs stub
  425.  
  426.    SYNOPSIS
  427.     success = GE_ResizeGeometry(GUI, Tags)
  428.  
  429.     BOOL GE_ResizeGeometry(GUI *, struct TagItem *)
  430.  
  431.     success = GE_ResizeGeometry(GUI, Tags,...)
  432.  
  433.     BOOL GE_ResizeGeometry(GUI *, Tag,...)
  434.  
  435.    FUNCTION
  436.     Layout all objects in the GUI.  This should be called whenever the
  437.     window is resized.
  438.  
  439.    INPUTS
  440.     Tags:
  441.  
  442.     GE_Geometry    - Resize this geometry under the given GUI envirionment
  443.  
  444.    RESULT
  445.  
  446.    EXAMPLE
  447.  
  448.    NOTES
  449.  
  450.    BUGS
  451.  
  452.    SEE ALSO
  453.  
  454.